home *** CD-ROM | disk | FTP | other *** search
/ SGI Developer Toolbox 6.1 / SGI Developer Toolbox 6.1 - Disc 4.iso / public / plan / src / README < prev    next >
Text File  |  1994-08-01  |  6KB  |  122 lines
  1.  
  2. plan - an X/Motif day planner
  3. -----------------------------
  4.  
  5. Note for people who don't read long READMEs: before you compile, edit the
  6. Makefile and change the LIB and DIR paths if you don't want all files to
  7. go into /usr/local/bin. Type "make help" for a list of supported platforms.
  8.  
  9. If you start a precompiled but uninstalled version, be sure to do it in
  10. the directory that contains plan, pland, notifier, and plan.help.
  11.  
  12. ---
  13.  
  14. Plan is a schedule planner based on X/Motif. It displays a month calendar
  15. similar to xcal, but every day box is large enough to show appointments
  16. in small print. By pressing on a day box, the appointments for that day
  17. can be listed and edited. Appointments are entered with the following
  18. information (everything except the time is optional):
  19.  
  20. - the date, time, and length of the appointment
  21. - an optional text message to be printed,
  22. - an optional script to be executed,
  23. - early-warn and late-warn triggers that precede the alarm time
  24. - repetitions: [n-th] weekdays, days-of-the-month, every n days, yearly
  25. - optional fast command-line appointment entry
  26. - flexible ways to specify holidays and vacations
  27. - extensive context help
  28.  
  29. The action being taken when a warn or alarm time is reached is programmable;
  30. by default a window pops up. In addition, a program can be executed, or mail
  31. can be sent. Other methods of listing appointments (today, this week, next
  32. week, or a keyword search for regular expressions) are also available. Plan
  33. can be configured to display times in 12-hour or 24-hour formats, mmddyy and
  34. ddmmyy date formats, and can show either Monday or Sunday in the leftmost
  35. column. Three view modes are supported: one month, one year, and one week.
  36. The week view plots appointments as colored and labelled bars in a hour vs.
  37. day chart, and allows other users' appointments to be included.
  38.  
  39. You do not need root access to install and run these programs. Edit the
  40. Makefile to change the installation directories (default /usr/local/bin),
  41. and run "make <systemname>". Default is sgi. For a list of supported system
  42. names, run "make help".
  43.  
  44. You'll have to copy the nroff manpage plan.[14], or the plain-text manpage
  45. plan.[14]cat (don't forget to strip the "cat") to your manpage directories
  46. manually, because that _does_ require root privileges.
  47.  
  48.  
  49. This distributions creates three binaries:
  50.  
  51. plan        the schedule program. It displays the calendar and allows
  52.             entry of appointments. It writes everything to a .dayplan*
  53.             files in the user's home directory. It does not check for
  54.             alarms, this is done by the pland daemon. plan informs pland
  55.             when the ~/.dayplan file changed by sending a hangup signal
  56.             to pland. plan can be used without the other programs, but
  57.             no alarms will be triggered.
  58.  
  59. pland       the daemon that waits for alarm events, and pops up windows,
  60.             sends mail, and/or executes a program when an alarm time is
  61.             reached. It creates a lockfile /tmp/.planUID, with UID being
  62.             the user's user ID. The lockfile prevents multiple pland's.
  63.             It also contains pland's process ID, which is read by plan
  64.             to find out where the hangup signals should be sent. pland
  65.             should be started in the user's .sgisession or .xsession file.
  66.  
  67. notifier    a program that prints a file (or standard input) into a
  68.             window. Depending on the options, the window is green, yellow,
  69.             or red. pland uses notifier to display messages; notifier was
  70.             not integrated into pland to keep the pland executable as
  71.             small as possible (X/Motif programs tend to be very large).
  72.  
  73. Plan.icon   for SGI systems. Copy this file to your ~/.icons directory
  74.             to get a full-color icon.
  75. plan_cal.ps the PostScript skeleton for the print functions, should go
  76.             into /usr/local/bin (see LIB in the Makefile)
  77. plan.help   all help texts, should go into /usr/local/bin (see LIB in
  78.             the Makefile)
  79. Mkdoc       a contributed perl script that converts plan.help to troff
  80.             source.
  81. Killpland   a contributed perl script that can be called from ~/.logout
  82.             to kill pland on logout.
  83. Monochrome  a sample resource list for monochrome systems, to be appended
  84.             to ~/.Xdefaults .
  85.  
  86. plan and notifier print usage messages when an unknown option is used;
  87. pland has only one option, -k, that kills the existing daemon first if
  88. there is one. In particular, plan -d and notifier -d dump the default X
  89. resources; you can do "plan -d >>.Xdefaults" and modify the resources.
  90. Make sure the plan.help file is in your search path.
  91.  
  92. Note -- I do not guarantee the accuracy of the .holiday template files
  93. in the distribution.
  94.  
  95.  
  96. Bug reports to thomas@bitrot.in-berlin.de. Don't forget to include the
  97. version number as printed by "plan -v".
  98.  
  99.  
  100. Copyright:
  101.  
  102. plan is Copyrighted by Thomas Driemeyer, 1993, 1994. License to copy,
  103. publish, and distribute is granted to everyone provided that three
  104. conditions are met:
  105.  
  106. - my name and email address, "Thomas Driemeyer <thomas@bitrot.in-
  107.   berlin.de>" must remain in the distribution and any documentation
  108.   that was not part of this distribution. In particular, my name
  109.   and address must be shown in the About popup.
  110. - if you redistribute a modified version, the fact that the version
  111.   is modified must be stated in all places that my name is shown.
  112. - this copyright notice must be included in your distribution.
  113.  
  114. If these conditions are met, you can do whatever you like. The
  115. idea is that I would be pissed if someone else claimed he wrote the
  116. thing, and I don't want bugs introduced by others attributed to me.
  117. Make as much money with it as you can. Drop me a line, I am curious.
  118.  
  119. There are no implied or expressed warranties for plan. I do not
  120. claim it is good for anything whatsoever, and if you lose your
  121. precious data or your dog dies this is entirely your problem.
  122.